Favicon

You are here: Home > API Reference > App Distribution > Build > Get list of builds

Get list of builds

Required Permission: mad.build.management.list

Get list of builds

GET
https://api.applivery.io/v1/organizations/{organizationId}/apps/{applicationId}/builds
curl -X GET "https://api.applivery.io/v1/organizations/{organizationId}/apps/{applicationId}/builds" \
  -H "Authorization: Bearer <YOUR_API_KEY>"
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/apps/{applicationId}/builds", {
  method: "GET",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
  },
});

const data = await response.json();
import requests

response = requests.get(
    "https://api.applivery.io/v1/organizations/{organizationId}/apps/{applicationId}/builds",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$
applicationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

page string
optional
limit string
optional
sort string
optional
status string
optional
pendingin_progresswaiting_to_be_processedprocessederror
os string
optional
iosandroidaospmacoswindowspackage
tags any
optional
signingType string
optional
appStoreenterprisead-hocdevelopmenttestFlight
metadata object
optional
version string
optional
≤ 500 characters
versionName string
optional
≤ 500 characters
platform string
optional
≤ 128 characters
gitTag string
optional
≤ 500 characters
gitBranch string
optional
≤ 500 characters
package string
optional
≤ 500 characters
fileName string
optional
≤ 500 characters
versionCode string
optional
≤ 500 characters
search string
optional
≤ 500 characters

Responses

200 Response application/json
status boolean required
data object required
items array [object] required
id string required
Match pattern: ^[a-fA-F0-9]{24}$
organizationInfo object optional
status string required
pending in_progress waiting_to_be_processed processed error
tags array [string] required
versionName string optional
≤ 256 characters
application string required
Match pattern: ^[a-fA-F0-9]{24}$
applicationInfo object optional
changelog string optional
file object optional
fileSimulator object optional
iconFile object optional
info object optional
size integer optional
≥ 0 · ≤ 9007199254740991
processTime integer optional
≥ 0 · ≤ 9007199254740991
queuedTime integer optional
≥ 0 · ≤ 9007199254740991
processedVersionName string optional
≤ 128 characters
versionCode string optional
≤ 128 characters
error string optional
errorCode string optional
≤ 128 characters
os string optional
ios android aosp macos windows package
buildPlatform string optional
≤ 128 characters
deployer object required
notifications object required
uploadedBy object optional
originalExtension string required
≤ 128 characters
storageProvider object required
processLogs array [object] required
files array [object] required
originalFile object optional
extraFiles array [object] optional
metadata object required
buildProcessor object optional
counts object optional
externalFileUrl string optional
≤ 500 characters
disabled any optional
extension string required
hasEmmJson any required
defaultScripts object optional
updatedAt string required
createdAt string required
totalDocs integer required
≥ -9007199254740991 · ≤ 9007199254740991
limit integer required
≥ -9007199254740991 · ≤ 9007199254740991
hasPrevPage boolean required
hasNextPage boolean required
page integer required
≥ -9007199254740991 · ≤ 9007199254740991
totalPages integer required
≥ -9007199254740991 · ≤ 9007199254740991
prevPage integer required
≥ -9007199254740991 · ≤ 9007199254740991
nextPage integer required
≥ -9007199254740991 · ≤ 9007199254740991
{
    "status": true,
    "data": {
        "items": [
            {
                "id": "string",
                "organizationInfo": {
                    "id": "string",
                    "name": "string",
                    "slug": "string",
                    "picture": "string",
                    "createdBy": "string",
                    "branding": {
                        "logo": "string",
                        "picture": "string",
                        "primaryColor": "string"
                    },
                    "store": {
                        "customDomain": "string"
                    },
                    "configuration": {
                        "storageProvider": "string"
                    }
                },
                "status": "pending",
                "tags": [
                    "string"
                ],
                "versionName": "string",
                "application": "string",
                "applicationInfo": {
                    "id": "string",
                    "name": "string",
                    "slug": "string",
                    "picture": "string"
                },
                "changelog": "string",
                "file": {
                    "originalName": "string",
                    "mimetype": "string",
                    "size": 0,
                    "bucket": "string",
                    "key": "string",
                    "location": "string",
                    "region": "string",
                    "storageProviderId": "string",
                    "checksum": "string",
                    "updatedAt": "string",
                    "createdAt": "string"
                },
                "fileSimulator": {
                    "originalName": "string",
                    "mimetype": "string",
                    "size": 0,
                    "bucket": "string",
                    "key": "string",
                    "location": "string",
                    "region": "string",
                    "storageProviderId": "string",
                    "checksum": "string",
                    "updatedAt": "string",
                    "createdAt": "string"
                },
                "iconFile": {
                    "originalName": "string",
                    "mimetype": "string",
                    "size": 0,
                    "bucket": "string",
                    "key": "string",
                    "location": "string",
                    "region": "string",
                    "storageProviderId": "string",
                    "checksum": "string",
                    "updatedAt": "string",
                    "createdAt": "string"
                },
                "info": {
                    "icon": "string",
                    "ios": {
                        "plist": {
                            "CFBundleName": "string",
                            "CFBundleDisplayName": "string",
                            "CFBundleVersion": "string",
                            "CFBundleShortVersionString": "string",
                            "CFBundleIdentifier": "string",
                            "CFBundleSupportedPlatforms": [
                                "string"
                            ],
                            "MinimumOSVersion": "string",
                            "CFBundleIcons": [
                                "string"
                            ],
                            "UIDeviceFamily": [
                                "string"
                            ]
                        },
                        "mobileprovision": {
                            "TeamIdentifier": "string",
                            "ProvisionsAllDevices": true,
                            "ProvisionedDevices": "string",
                            "TeamName": "string",
                            "ExpirationDate": "string",
                            "signingType": "appStore"
                        }
                    },
                    "android": {
                        "versionCode": "string",
                        "versionName": "string",
                        "platformBuildVersionCode": "string",
                        "platformBuildVersionName": "string",
                        "packageName": "string",
                        "minSDKVersion": "string",
                        "targetSdkVersion": "string",
                        "icon": "string",
                        "productName": "string",
                        "managedConfigurations": [
                            {
                                "key": "string",
                                "title": "string",
                                "description": "string",
                                "restrictionType": "NULL",
                                "defaultValue": "string",
                                "entries": [
                                    "string"
                                ],
                                "entryValues": [
                                    "string"
                                ],
                                "minValue": 0,
                                "maxValue": 0,
                                "visible": true
                            }
                        ]
                    },
                    "pkg": {
                        "CFBundleName": "string",
                        "CFBundleDisplayName": "string",
                        "CFBundleVersion": "string",
                        "CFBundleShortVersionString": "string",
                        "CFBundleIdentifier": "string",
                        "CFBundleSupportedPlatforms": [
                            "string"
                        ],
                        "MinimumOSVersion": "string",
                        "relatedPkgs": [
                            {
                                "distribution": {
                                    "id": "string",
                                    "active": "string",
                                    "auth": "string",
                                    "installKBytes": "string",
                                    "onConclusion": "string",
                                    "onConclusionScript": "string",
                                    "version": "string",
                                    "archiveKBytes": "string",
                                    "packageIdentifier": "string",
                                    "text": "string"
                                },
                                "plistInfo": {
                                    "CFBundleName": "string",
                                    "CFBundleDisplayName": "string",
                                    "CFBundleVersion": "string",
                                    "CFBundleShortVersionString": "string",
                                    "CFBundleIdentifier": "string",
                                    "CFBundleSupportedPlatforms": [
                                        "string"
                                    ],
                                    "MinimumOSVersion": "string"
                                },
                                "iconFile": "string"
                            }
                        ]
                    },
                    "app": {
                        "CFBundleName": "string",
                        "CFBundleDisplayName": "string",
                        "CFBundleVersion": "string",
                        "CFBundleShortVersionString": "string",
                        "CFBundleIdentifier": "string",
                        "CFBundleSupportedPlatforms": [
                            "string"
                        ],
                        "CFBundlePackageType": "string",
                        "LSMinimumSystemVersion": "string"
                    },
                    "msi": {
                        "productCode": "string",
                        "productVersion": "string",
                        "productName": "string",
                        "manufacturer": "string"
                    },
                    "exe": {
                        "fileSize": "string",
                        "fileVersionNumber": "string",
                        "fileOS": "string",
                        "fileDescription": "string",
                        "fileVersion": "string",
                        "originalFileName": "string",
                        "productName": "string",
                        "productVersion": "string",
                        "companyName": "string"
                    },
                    "msixbundle": {
                        "applicationsData": [
                            {
                                "arch": "string",
                                "fileName": "string",
                                "size": "string",
                                "version": "string"
                            }
                        ],
                        "packageName": "string",
                        "version": "string"
                    },
                    "appxbundle": {
                        "applicationsData": [
                            {
                                "arch": "string",
                                "fileName": "string",
                                "size": "string",
                                "version": "string"
                            }
                        ],
                        "packageName": "string",
                        "version": "string"
                    },
                    "msix": {
                        "displayName": "string",
                        "publisherDisplayName": "string",
                        "version": "string",
                        "arch": "string",
                        "name": "string"
                    },
                    "appx": {
                        "displayName": "string",
                        "publisherDisplayName": "string",
                        "version": "string",
                        "arch": "string",
                        "name": "string"
                    },
                    "scripts": {
                        "preInstall": "string",
                        "postInstall": "string"
                    },
                    "package": {
                        "name": "string",
                        "version": "string"
                    }
                },
                "size": 0,
                "processTime": 0,
                "queuedTime": 0,
                "processedVersionName": "string",
                "versionCode": "string",
                "error": "string",
                "errorCode": "string",
                "os": "ios",
                "buildPlatform": "string",
                "deployer": {
                    "name": "string",
                    "info": {
                        "commitMessage": "string",
                        "commit": "string",
                        "branch": "string",
                        "triggerTimestamp": "string",
                        "buildUrl": "string",
                        "ciUrl": "string",
                        "repositoryUrl": "string",
                        "buildNumber": "string",
                        "tag": "string"
                    }
                },
                "notifications": {
                    "notifyCollaborators": true,
                    "notifyEmployees": true,
                    "message": "string",
                    "language": "es",
                    "filter": [
                        [
                            "string"
                        ]
                    ]
                },
                "uploadedBy": {
                    "id": "string",
                    "email": "[email protected]",
                    "firstName": "string",
                    "lastName": "string",
                    "picture": "string"
                },
                "originalExtension": "string",
                "storageProvider": {
                    "id": "string",
                    "name": "string",
                    "region": "string",
                    "config": "string",
                    "provider": "string"
                },
                "processLogs": [
                    {
                        "dateMs": 0,
                        "message": "string"
                    }
                ],
                "files": [
                    {
                        "id": "string",
                        "type": "aab",
                        "description": "string",
                        "file": {
                            "originalName": "string",
                            "mimetype": "string",
                            "size": 0,
                            "bucket": "string",
                            "key": "string",
                            "location": "string",
                            "region": "string",
                            "storageProviderId": "string",
                            "checksum": "string",
                            "updatedAt": "string",
                            "createdAt": "string"
                        },
                        "metadata": {}
                    }
                ],
                "originalFile": {
                    "originalName": "string",
                    "mimetype": "string",
                    "size": 0,
                    "bucket": "string",
                    "key": "string",
                    "location": "string",
                    "region": "string",
                    "storageProviderId": "string",
                    "checksum": "string",
                    "updatedAt": "string",
                    "createdAt": "string"
                },
                "extraFiles": [
                    {
                        "target": "string",
                        "file": {
                            "originalName": "string",
                            "mimetype": "string",
                            "size": 0,
                            "bucket": "string",
                            "key": "string",
                            "location": "string",
                            "region": "string",
                            "storageProviderId": "string",
                            "checksum": "string",
                            "updatedAt": "string",
                            "createdAt": "string"
                        }
                    }
                ],
                "metadata": {},
                "buildProcessor": {
                    "provider": "string",
                    "runName": "string",
                    "runId": "string"
                },
                "counts": {
                    "downloads": {},
                    "downloadByDay": {},
                    "downloadsByMonth": {}
                },
                "externalFileUrl": "string",
                "disabled": true,
                "extension": "string",
                "hasEmmJson": true,
                "defaultScripts": {
                    "preInstall": "string",
                    "postInstall": "string",
                    "audit": "string",
                    "enforce": "string",
                    "runner": "string"
                },
                "updatedAt": "string",
                "createdAt": "string"
            }
        ],
        "totalDocs": 0,
        "limit": 0,
        "hasPrevPage": true,
        "hasNextPage": true,
        "page": 0,
        "totalPages": 0,
        "prevPage": 0,
        "nextPage": 0
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}